BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_2 / qd10.zip / Q&D10.DOC next >

Wrap

Text File | 1992-09-13 | 17KB | 429 lines

┌───────────────────────────────────────────────┐ │ Q U I C K & D I R T Y │ │ Version 1.0 │ │ Initial release after Alpha tests │ └─────────[ Copyright 1992, Pat Marr ]─────────┘ Compiled 9/11/1992 NOTE: where the filename "Q&D" is used in the docs, substitute the current version's file name where syntax is being described. (for example "Q&D10" if current version is 1.0) --------------------------------------------------------------------------- OVERVIEW: --------- QUICK & DIRTY is an online game that uses ANSI codes to write directly to the sysop's and user's screen, so small screen updates can be made without having to endure the irritation of watching the entire screen reprint everytime the game player presses a key!! Since Ansi is required, you should probably note that fact on your game menu, as non-ansi callers who try to play won't have much fun. The game is an online version of the old hand-help puzzle which required you to rearrange letters until they were back in alphabetical order. One difference is that Q&D allows you to cheat a little by swapping 2 letters if you get in a pinch! The game also generates an ASCII and an ANSI scoreboard file, for those who like to see the scores without actually playing the game. Q&D also allows use of multiple configuration files, so the game can be played on multi node BBSes. It should be noted, however, that the game can not be played simultaneously from more than one port (not even if you use separate copies of the game for each port.) Q&D is a good choice for "occasional" playing. It doesn't require a daily commitment like some games do. If your game menu is currently full of "ongoing games", Q&D might provide something a little different. ---------------------------------------------------------------------------- BBS COMPATIBILITY ----------------- Q&D should be able to access the following types of BBS door user files: CHAIN.TXT (WWIV and VBBS) GTUSER.BBS (GT POWER) CALLINFO.BBS (old versions of WILDCAT!, long version of CALLINFO only) DOOR.SYS (new WILDCAT!, GAP, and a few others since it is a standard) DORINFO1.DEF (RBBS) SFDOORS.DAT (SPITFIRE) DOORUSER.DAT (SCANLINE) PCBOARD.SYS (PCBOARD) In an effort to make the games run on other MS-DOS BBS systems not mentioned above, there is an option to let the players "sign in" instead of reading the users name from your door user file. Therefore, I believe it is safe to say that Q&D will run on ANY MS-DOS based BBS with ANSI. If you find that Q&D fails to read the caller's name correctly from one of these BBS files, please let me know about it so the problem may be fixed. (My address is at the end of these docs...) ------------------------------------------------------------------------------- BBS SETUP INSTRUCTIONS: ----------------------- step 1: Create a directory for the game files. As an example, we'll assume you named the new directory "\GAMES" (but you can use any legal directory name) step 2: Copy the files to the new directory step 3: Do whatever you normally do to add an online game to your BBS's game menu step 4: To configure the game for your system, play it the first time fron DOS (not as a door). The game will look for its support files, and if it doesn't find them, it will execute a configuration procedure. This procedure will prompt you for info about your system, then it will write your responses to an ASCII file. If you prefer, you may create the ascii configuration file with a text editor rather than using the config utility. The file must include the following 8 items, each on a separate line: * Name of your BBS * phone # of your BBS * City & state of your BBS * Com port used by BBS/online games (1 - 4) * full pathname of door info file (chain.txt, door.sys, etc) note: if you would like the game to prompt players to enter their names each time they play, rather than reading the names from your BBS door file, then leave this space blank. * full pathname for saving ANSI top ten scoreboard * full pathname for saving ASCII top ten scoreboard Scoreboard file notes: ** Pathnames should NOT include DRIVE letter ** If no filename is specified, then no top ten file will be created ** If you specify a directory other than the directory in which the game is located, it is your responsibility to make sure that such a directory exists. * Y or N to designate whether you need a high speed modem handshake note: N = XON-XOFF handshake, Y = CTS handshake plus XON-XOFF NOTE: you can make additional config files as follows: * Edit your original text file with a text editor, or..... * Use Q&D's built-in config feature by specifying a config filename as a command line parameter when first running the game from DOS. Each time you specify a new filename, a new config file is created. For example: The command "Q&D CONFIG.001" will create a new config file named CONFIG.001 if it doesn't already exist. If the file already exists, then Q&D will execute, using the configuration found in CONFIG.001 If no config filename is specified, the default name CONFIG.Q&D is used. step 5 : Generic syntax to run Q&D on a single node BBS is: \DIRNAME\Q&D ^-------------^ | (full Q&D Path) If your BBS's dooruser file is not supported, or if Q&D fails to read your door user file correctly, you can bypass the problem by omitting the dooruser filename from Q&D's config file. If no door user filename is specified, the user will be prompted to enter his name. Alternate step 5 (for multi node BBSes) On multi node BBSes it will be necessary to create a config file for each node, because the config file dictates which com port to use, and the path name for your door user file (which is different for each node on multi node BBSes) In order to let Q&D know which config file to use, you should add the name of the config file as a parameter when starting the game. For example.... Generic syntax to run Q&D from node 1: \DIRNAME\Q&D NODE1.CFG ^------------^---------^ | | (full Q&D Path) (Name of config file you prepared for node 1. The filename may be anything you choose.) You can create the config file by starting the game from DOS (not as a door), specifying the filename. Each time you specify a new config filename, the configuration module will create a new config file with that name. Config files should be located in the same directory as the game. Likewise, to run the game from node 2.... \DIRNAME\Q&D NODE2.CFG --------- | Node2.cfg would be the same as node1.cfg, except it would specify com2 instead of com1, and it would specify a different pathname for the door user file (chain.txt, door.sys) NOTE: Just naming the file NODE2.cfg isn't what causes the game to use node 2.... the config file itself must be edited to specify a new node and dooruser path. ---------------------------------------------------------------------------- BATCH FILES: ------------ If you use the syntax as specified, you won't need to use a batch file to change directories. Q&D checks the Environment to find out what directory it's in, and looks there for its data files. You never need to leave the BBS directory at all! For some reason (unbeknownst to me) using a batch file to run the games causes the final message "please wait while BBS reloads..." to vanish!! Therefore I recommend running the games without a batch file. The only time you might NEED to use a batch file is if you plan to run Q&D on a different drive than the BBS is on (a ramdisk, for example). Generally speaking, I'd avoid running it on a different drive, because the routines that let Q&D know where to find its support files check only on the CURRENT drive. So, if you run on a different drive, you'll need a batch file to change drives/directories, and you'll also need to add the drivespec to all your file references (like the name of the BBS user file...) Sample batch file: @ ECHO OFF D: <--change to other drive COPY C:\GAMES\*.* D: <-- copy game files from hard disk to ram disk Q&D NODE1.CFG <-- play game, specifying which config file to use if multi node COPY D:*.* C:\GAMES <-- copy game files back to hard drive directory C: <--change back after game CD \WWIV <--get bbs directory --------------------------------------------------------------------------- CONSIDERATIONS : ---------------- If your BBS handles the communications I/O by intercepting DOS calls and rerouting them through the serial port, then you'll need to set the "INTERCEPT DOS" switch to "OFF" or "N" (whatever). This is NOT optional! Leaving the INTERCEPT DOS switch on will definitely crash your system! ---------------------------- The drive on which Q&D is loaded should be the same as the drive the BBS is on. For example, if the BBS is on drive C: then trying to run Q&D from drive D: will result in file errors, since it will be looking on drive C: for its support files. (see batch file sample above for solution) ------------------------------------------------------------------------------ RUNNING THE GAMES, BUT NOT AS A DOOR: ------------------------------------- syntax: Q&D (if running game from its own directory...) --- or --- files are in the same \GAMES\Q&D (If running game from a different directory. Game doesn't need to be played from its own directory, because it knows where to find its support files) --- or --- \GAMES\Q&D NODE1.CFG (If you want to use one of several config files, then specify the config file to be used) Syntax is actually the same as a door and as a standalone game. ----------------------------------------------------------------------------- REGISTRATION: ------------- None required. I've gotten a lot out of BBSing, and hopefully, this will put a little back. Please distribute unmodified versions of Q&D freely to other BBSes. If you run Q&D on your BBS, please mail me your Name, Address, BBS name & phone number... (This isn't required, it just gives me a random sampling of where the game is being played already) If you like Q&D, and send me a self addressed stamped floppy/mailer, along with whatever type of diskette your IBM compatible computer uses and I'll send you copies of several other online games I've written: * ANSIGAMES is 4 games in one: Hangman, Lotto, Dice and Lost Wallet * JUMBLE is a word unscrambling game, with various levels of play. All these games are fully functional, and require no registration. --------------------------------------------------------------------------- RE-ROLLING THE GAME (starting over) ----------------------------------- You can reroll the game by deleting all the .Q&D files in the Q&D directory. Q&D will create new files to replace the deleted ones, but you WILL need to run the game from DOS again to recreate the config file(s) If you created multiple config files, or config files that don't end with the extension ".Q&D" then you may also need to delete them too. However, if you only want to start the scores over, then just delete the SCORES.Q&D file and the topten ANSI/ASCII files. ----------------------------------------------------------------------------- AUTHOR'S ADDRESS ---------------- Have fun. If you have any questions or suggestions, you may contact me.... 1) By calling FRINC BBS, Winston Salem NC (919) 768-2556 (handle = Pat Marr) 2) On WWIVNET, I can be reached as 30@9986 (FRINC's node #) 3) On FIDO I can be reached at 1:151/601, user name = Pat Marr or by calling Ronnie's Private BBS (919) 760-4087 4) By US Mail at: Pat Marr 5188 Little Brook Lane Winston-Salem, NC 27104 (919) 760-3187 ------------------------------------------------------------------------------- WANNA HELP? ------------ * You can help me by uploading Q&D to at least 1 other BBS.... :-) * Better yet, call the two BBSes that so graciously support my games, and tell the sysop you got his phone number from QUICK & DIRTY's docs! I'd hate for them to think they've helped support a game that nobody ever plays!! (see phone numbers below) ------------------------------------------------------------------------------- THANKS TO... ------------ 1) Ronnie Abernathy, Sysop at RONNIE'S PRIVATE BBS in Winston Salem NC. (919) 760-4087 (running WILDCAT 3.xx multi node software) Ronnie has provided the creative insight behind several of the game's features, suggesting (among other things) the ansi/ascii score files and the ability to let the game use multiple config files, a feature necessary for multi node BBSes. Without his constant encouragement, Alpha testing, and BBS support, the ANSIGAME series of online games would never have been possible. FIDO sysops should be able to FREQ Q&D from Ronnie at node 1:151/601 If you like Q&D, you may also want to try ANSIGAMES or JUMBLE... (also available for DL on Ronnie's BBS) All 3 require ANSI, and should appeal to approximately the same type of players. 2) Brad Trogden (aka REPO MAN) SYSOP at FRINC BBS in Winston Salem NC. (919) 768-2556 (running WWIV 4.20 software WWIVNET NODE 9986) Brad has graciously offered his BBS as the official ANSIGAMES/JUMBLE support BBS. If there is a new version of Q&D, ANSIGAMES or JUMBLE, it will be available on FRINC. (in fact FRINC's cd-ROM and large hard drive are FULL of files, many of which are online games...) 3) And thanks to YOU for running Q&D on YOUR BBS!